<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>diagram(Format) &mdash; Logtalk APIs v3.93.0-b01 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d75fae25" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
      <link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=0e9007aa" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=c8100655"></script>
        <script src="_static/doctools.js?v=9a2dae69"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/js/theme.js"></script>
    <!-- begin favicon -->
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
    <link rel="manifest" href="/site.webmanifest" />
    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5" />
    <meta name="msapplication-TileColor" content="#355b95" />
    <meta name="theme-color" content="#ffffff" />
    <!-- end favicon -->
    
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="diagrams" href="diagrams_0.html" />
    <link rel="prev" title="d2_graph_language" href="d2_graph_language_0.html" />
   
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="index.html" class="icon icon-home">
            Logtalk APIs
              <img src="_static/logtalk.gif" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                3.93.0
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
    
              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="library_index.html">Libraries</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="library_index.html#arbitrary"><span class="xref std std-ref">arbitrary</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#assertions"><span class="xref std std-ref">assertions</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#assignvars"><span class="xref std std-ref">assignvars</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#base64"><span class="xref std std-ref">base64</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#cbor"><span class="xref std std-ref">cbor</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#code-metrics"><span class="xref std std-ref">code_metrics</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#core"><span class="xref std std-ref">core</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#coroutining"><span class="xref std std-ref">coroutining</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#csv"><span class="xref std std-ref">csv</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dates"><span class="xref std std-ref">dates</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dead-code-scanner"><span class="xref std std-ref">dead_code_scanner</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#debug-messages"><span class="xref std std-ref">debug_messages</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#debugger"><span class="xref std std-ref">debugger</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dependents"><span class="xref std std-ref">dependents</span></a></li>
<li class="toctree-l2 current"><a class="reference internal" href="library_index.html#diagrams"><span class="xref std std-ref">diagrams</span></a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="d2_graph_language_0.html">d2_graph_language</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="diagrams_0.html">diagrams</a></li>
<li class="toctree-l3"><a class="reference internal" href="diagrams_1.html">diagrams(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_dependency_diagram_0.html">directory_dependency_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_dependency_diagram_1.html">directory_dependency_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_diagram_1.html">directory_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_load_diagram_0.html">directory_load_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="directory_load_diagram_1.html">directory_load_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="dot_graph_language_0.html">dot_graph_language</a></li>
<li class="toctree-l3"><a class="reference internal" href="entity_diagram_0.html">entity_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="entity_diagram_1.html">entity_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_dependency_diagram_0.html">file_dependency_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_dependency_diagram_1.html">file_dependency_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_diagram_1.html">file_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_load_diagram_0.html">file_load_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="file_load_diagram_1.html">file_load_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="graph_language_protocol_0.html">graph_language_protocol</a></li>
<li class="toctree-l3"><a class="reference internal" href="graph_language_registry_0.html">graph_language_registry</a></li>
<li class="toctree-l3"><a class="reference internal" href="inheritance_diagram_0.html">inheritance_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="inheritance_diagram_1.html">inheritance_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_dependency_diagram_0.html">library_dependency_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_dependency_diagram_1.html">library_dependency_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_diagram_1.html">library_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_load_diagram_0.html">library_load_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="library_load_diagram_1.html">library_load_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules_diagram_support_0.html">modules_diagram_support</a></li>
<li class="toctree-l3"><a class="reference internal" href="uses_diagram_0.html">uses_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="uses_diagram_1.html">uses_diagram(Format)</a></li>
<li class="toctree-l3"><a class="reference internal" href="xref_diagram_0.html">xref_diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="xref_diagram_1.html">xref_diagram(Format)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dictionaries"><span class="xref std std-ref">dictionaries</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#dif"><span class="xref std std-ref">dif</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#doclet"><span class="xref std std-ref">doclet</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#edcg"><span class="xref std std-ref">edcg</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#events"><span class="xref std std-ref">events</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#expand-library-alias-paths"><span class="xref std std-ref">expand_library_alias_paths</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#expecteds"><span class="xref std std-ref">expecteds</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#fcube"><span class="xref std std-ref">fcube</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#flags"><span class="xref std std-ref">flags</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#format"><span class="xref std std-ref">format</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#genint"><span class="xref std std-ref">genint</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#gensym"><span class="xref std std-ref">gensym</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#git"><span class="xref std std-ref">git</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#grammars"><span class="xref std std-ref">grammars</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#heaps"><span class="xref std std-ref">heaps</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#help"><span class="xref std std-ref">help</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hierarchies"><span class="xref std std-ref">hierarchies</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hook-flows"><span class="xref std std-ref">hook_flows</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#hook-objects"><span class="xref std std-ref">hook_objects</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#html"><span class="xref std std-ref">html</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ids"><span class="xref std std-ref">ids</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#intervals"><span class="xref std std-ref">intervals</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#iso8601"><span class="xref std std-ref">iso8601</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#issue-creator"><span class="xref std std-ref">issue_creator</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#java"><span class="xref std std-ref">java</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#json"><span class="xref std std-ref">json</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#json-lines"><span class="xref std std-ref">json_lines</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#lgtdoc"><span class="xref std std-ref">lgtdoc</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#lgtunit"><span class="xref std std-ref">lgtunit</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#library"><span class="xref std std-ref">library</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#listing"><span class="xref std std-ref">listing</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#logging"><span class="xref std std-ref">logging</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#loops"><span class="xref std std-ref">loops</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#meta"><span class="xref std std-ref">meta</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#meta-compiler"><span class="xref std std-ref">meta_compiler</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#metagol"><span class="xref std std-ref">metagol</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#mutations"><span class="xref std std-ref">mutations</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#nested-dictionaries"><span class="xref std std-ref">nested_dictionaries</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#optionals"><span class="xref std std-ref">optionals</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#options"><span class="xref std std-ref">options</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#os"><span class="xref std std-ref">os</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#packs"><span class="xref std std-ref">packs</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#pddl-parser"><span class="xref std std-ref">pddl_parser</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ports-profiler"><span class="xref std std-ref">ports_profiler</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#queues"><span class="xref std std-ref">queues</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#random"><span class="xref std std-ref">random</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#reader"><span class="xref std std-ref">reader</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#recorded-database"><span class="xref std std-ref">recorded_database</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#redis"><span class="xref std std-ref">redis</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#sets"><span class="xref std std-ref">sets</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#statistics"><span class="xref std std-ref">statistics</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#term-io"><span class="xref std std-ref">term_io</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#timeout"><span class="xref std std-ref">timeout</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#toychr"><span class="xref std std-ref">toychr</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#tsv"><span class="xref std std-ref">tsv</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#tutor"><span class="xref std std-ref">tutor</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#types"><span class="xref std std-ref">types</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#ulid"><span class="xref std std-ref">ulid</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#union-find"><span class="xref std std-ref">union_find</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#uuid"><span class="xref std std-ref">uuid</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#verdi-neruda"><span class="xref std std-ref">verdi_neruda</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#wrapper"><span class="xref std std-ref">wrapper</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#xml-parser"><span class="xref std std-ref">xml_parser</span></a></li>
<li class="toctree-l2"><a class="reference internal" href="library_index.html#zippers"><span class="xref std std-ref">zippers</span></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="directory_index.html">Directories</a></li>
<li class="toctree-l1"><a class="reference internal" href="entity_index.html">Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="predicate_index.html">Predicates</a></li>
</ul>

    <ul>
    <li class="toctree-l1"><a class="reference internal" href="core_inheritance_diagram.svg">Core diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="library_inheritance_diagram.svg">Libraries diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="tools_inheritance_diagram.svg">Tools diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="ports_inheritance_diagram.svg">Ports diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="contributions_inheritance_diagram.svg">Contributions diagram</a></li>
    <li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
    </ul>
    <p class="caption"><span class="caption-text">External Contents</span></p>
    <ul>
    <li class="toctree-l1"><a class="reference internal" href="../handbook/index.html">Handbook</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://logtalk.org">Logtalk website</a></li>
    <li class="toctree-l1"><a class="reference internal" href="https://github.com/LogtalkDotOrg/logtalk3">GitHub repo</a></li>
    </ul>
  
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Logtalk APIs</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="library_index.html">Libraries</a></li>
      <li class="breadcrumb-item active"><code class="docutils literal notranslate"><span class="pre">diagram(Format)</span></code></li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/diagram_1.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <p class="right" id="diagram-1"><span id="index-0"></span><strong>category</strong></p>
<section id="diagram-format">
<h1><code class="docutils literal notranslate"><span class="pre">diagram(Format)</span></code><a class="headerlink" href="#diagram-format" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Format</span></code> - Graph language file format.</p></li>
</ul>
<p>Common predicates for generating diagrams.</p>
<div class="line-block">
<div class="line"><strong>Availability:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">logtalk_load(diagrams(loader))</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Author:</strong> Paulo Moura</div>
<div class="line"><strong>Version:</strong> 3:15:0</div>
<div class="line"><strong>Date:</strong> 2024-12-04</div>
</div>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Extends:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">public</span></code> <a class="reference internal" href="options_0.html#options-0"><span class="std std-ref">options</span></a></div>
</div>
<div class="line"><strong>Provides:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="logtalk_0.html#logtalk-0-message-prefix-stream-4"><span class="std std-ref">logtalk::message_prefix_stream/4</span></a></div>
<div class="line"><a class="reference internal" href="logtalk_0.html#logtalk-0-message-tokens-2"><span class="std std-ref">logtalk::message_tokens//2</span></a></div>
</div>
<div class="line"><strong>Uses:</strong></div>
<div class="line-block">
<div class="line"><a class="reference internal" href="graph_language_registry_0.html#graph-language-registry-0"><span class="std std-ref">graph_language_registry</span></a></div>
<div class="line"><a class="reference internal" href="list_0.html#list-0"><span class="std std-ref">list</span></a></div>
<div class="line"><a class="reference internal" href="logtalk_0.html#logtalk-0"><span class="std std-ref">logtalk</span></a></div>
<div class="line"><a class="reference internal" href="modules_diagram_support_0.html#modules-diagram-support-0"><span class="std std-ref">modules_diagram_support</span></a></div>
<div class="line"><a class="reference internal" href="os_0.html#os-0"><span class="std std-ref">os</span></a></div>
<div class="line"><a class="reference internal" href="pairs_0.html#pairs-0"><span class="std std-ref">pairs</span></a></div>
<div class="line"><a class="reference internal" href="type_0.html#type-0"><span class="std std-ref">type</span></a></div>
<div class="line"><a class="reference internal" href="user_0.html#user-0"><span class="std std-ref">user</span></a></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Remarks:</strong></div>
<div class="line-block">
<div class="line">(none)</div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Inherited public predicates:</strong></div>
<div class="line-block">
<div class="line"> <a class="reference internal" href="options_protocol_0.html#options-protocol-0-check-option-1"><span class="std std-ref">check_option/1</span></a>  <a class="reference internal" href="options_protocol_0.html#options-protocol-0-check-options-1"><span class="std std-ref">check_options/1</span></a>  <a class="reference internal" href="options_protocol_0.html#options-protocol-0-default-option-1"><span class="std std-ref">default_option/1</span></a>  <a class="reference internal" href="options_protocol_0.html#options-protocol-0-default-options-1"><span class="std std-ref">default_options/1</span></a>  <a class="reference internal" href="options_protocol_0.html#options-protocol-0-option-2"><span class="std std-ref">option/2</span></a>  <a class="reference internal" href="options_protocol_0.html#options-protocol-0-option-3"><span class="std std-ref">option/3</span></a>  <a class="reference internal" href="options_protocol_0.html#options-protocol-0-valid-option-1"><span class="std std-ref">valid_option/1</span></a>  <a class="reference internal" href="options_protocol_0.html#options-protocol-0-valid-options-1"><span class="std std-ref">valid_options/1</span></a></div>
</div>
</div>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#public-predicates" id="id5">Public predicates</a></p>
<ul>
<li><p><a class="reference internal" href="#libraries-3" id="id6"><code class="docutils literal notranslate"><span class="pre">libraries/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#libraries-2" id="id7"><code class="docutils literal notranslate"><span class="pre">libraries/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#libraries-1" id="id8"><code class="docutils literal notranslate"><span class="pre">libraries/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#all-libraries-1" id="id9"><code class="docutils literal notranslate"><span class="pre">all_libraries/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#all-libraries-0" id="id10"><code class="docutils literal notranslate"><span class="pre">all_libraries/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#rlibrary-2" id="id11"><code class="docutils literal notranslate"><span class="pre">rlibrary/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#rlibrary-1" id="id12"><code class="docutils literal notranslate"><span class="pre">rlibrary/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#library-2" id="id13"><code class="docutils literal notranslate"><span class="pre">library/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#library-1" id="id14"><code class="docutils literal notranslate"><span class="pre">library/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#directories-3" id="id15"><code class="docutils literal notranslate"><span class="pre">directories/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#directories-2" id="id16"><code class="docutils literal notranslate"><span class="pre">directories/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#rdirectory-3" id="id17"><code class="docutils literal notranslate"><span class="pre">rdirectory/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#rdirectory-2" id="id18"><code class="docutils literal notranslate"><span class="pre">rdirectory/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#rdirectory-1" id="id19"><code class="docutils literal notranslate"><span class="pre">rdirectory/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#directory-3" id="id20"><code class="docutils literal notranslate"><span class="pre">directory/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#directory-2" id="id21"><code class="docutils literal notranslate"><span class="pre">directory/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#directory-1" id="id22"><code class="docutils literal notranslate"><span class="pre">directory/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#files-3" id="id23"><code class="docutils literal notranslate"><span class="pre">files/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#files-2" id="id24"><code class="docutils literal notranslate"><span class="pre">files/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#files-1" id="id25"><code class="docutils literal notranslate"><span class="pre">files/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#all-files-1" id="id26"><code class="docutils literal notranslate"><span class="pre">all_files/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#all-files-0" id="id27"><code class="docutils literal notranslate"><span class="pre">all_files/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#format-object-1" id="id28"><code class="docutils literal notranslate"><span class="pre">format_object/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#diagram-description-1" id="id29"><code class="docutils literal notranslate"><span class="pre">diagram_description/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#diagram-name-suffix-1" id="id30"><code class="docutils literal notranslate"><span class="pre">diagram_name_suffix/1</span></code></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#protected-predicates" id="id31">Protected predicates</a></p>
<ul>
<li><p><a class="reference internal" href="#diagram-caption-3" id="id32"><code class="docutils literal notranslate"><span class="pre">diagram_caption/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-rlibrary-3" id="id33"><code class="docutils literal notranslate"><span class="pre">output_rlibrary/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-library-3" id="id34"><code class="docutils literal notranslate"><span class="pre">output_library/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-rdirectory-3" id="id35"><code class="docutils literal notranslate"><span class="pre">output_rdirectory/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-externals-1" id="id36"><code class="docutils literal notranslate"><span class="pre">output_externals/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-files-2" id="id37"><code class="docutils literal notranslate"><span class="pre">output_files/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-file-4" id="id38"><code class="docutils literal notranslate"><span class="pre">output_file/4</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-sub-diagrams-1" id="id39"><code class="docutils literal notranslate"><span class="pre">output_sub_diagrams/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#reset-0" id="id40"><code class="docutils literal notranslate"><span class="pre">reset/0</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-node-6" id="id41"><code class="docutils literal notranslate"><span class="pre">output_node/6</span></code></a></p></li>
<li><p><a class="reference internal" href="#node-6" id="id42"><code class="docutils literal notranslate"><span class="pre">node/6</span></code></a></p></li>
<li><p><a class="reference internal" href="#edge-5" id="id43"><code class="docutils literal notranslate"><span class="pre">edge/5</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-edges-1" id="id44"><code class="docutils literal notranslate"><span class="pre">output_edges/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#save-edge-5" id="id45"><code class="docutils literal notranslate"><span class="pre">save_edge/5</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-missing-externals-1" id="id46"><code class="docutils literal notranslate"><span class="pre">output_missing_externals/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#not-excluded-file-4" id="id47"><code class="docutils literal notranslate"><span class="pre">not_excluded_file/4</span></code></a></p></li>
<li><p><a class="reference internal" href="#output-file-path-4" id="id48"><code class="docutils literal notranslate"><span class="pre">output_file_path/4</span></code></a></p></li>
<li><p><a class="reference internal" href="#locate-library-2" id="id49"><code class="docutils literal notranslate"><span class="pre">locate_library/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#locate-directory-2" id="id50"><code class="docutils literal notranslate"><span class="pre">locate_directory/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#locate-file-5" id="id51"><code class="docutils literal notranslate"><span class="pre">locate_file/5</span></code></a></p></li>
<li><p><a class="reference internal" href="#ground-entity-identifier-3" id="id52"><code class="docutils literal notranslate"><span class="pre">ground_entity_identifier/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#filter-file-extension-3" id="id53"><code class="docutils literal notranslate"><span class="pre">filter_file_extension/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#filter-external-file-extension-3" id="id54"><code class="docutils literal notranslate"><span class="pre">filter_external_file_extension/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#add-link-options-3" id="id55"><code class="docutils literal notranslate"><span class="pre">add_link_options/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#supported-editor-url-scheme-prefix-1" id="id56"><code class="docutils literal notranslate"><span class="pre">supported_editor_url_scheme_prefix/1</span></code></a></p></li>
<li><p><a class="reference internal" href="#omit-path-prefix-3" id="id57"><code class="docutils literal notranslate"><span class="pre">omit_path_prefix/3</span></code></a></p></li>
<li><p><a class="reference internal" href="#add-node-zoom-option-4" id="id58"><code class="docutils literal notranslate"><span class="pre">add_node_zoom_option/4</span></code></a></p></li>
<li><p><a class="reference internal" href="#message-diagram-description-1" id="id59"><code class="docutils literal notranslate"><span class="pre">message_diagram_description/1</span></code></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#private-predicates" id="id60">Private predicates</a></p>
<ul>
<li><p><a class="reference internal" href="#id1" id="id61"><code class="docutils literal notranslate"><span class="pre">node_/6</span></code></a></p></li>
<li><p><a class="reference internal" href="#node-path-2" id="id62"><code class="docutils literal notranslate"><span class="pre">node_path_/2</span></code></a></p></li>
<li><p><a class="reference internal" href="#id3" id="id63"><code class="docutils literal notranslate"><span class="pre">edge_/5</span></code></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#operators" id="id64">Operators</a></p></li>
</ul>
</nav>
<section id="public-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Public predicates</a><a class="headerlink" href="#public-predicates" title="Link to this heading"></a></h2>
<section id="libraries-3">
<span id="diagram-1-libraries-3"></span><span id="index-1"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">libraries/3</span></code></a><a class="headerlink" href="#libraries-3" title="Link to this heading"></a></h3>
<p>Creates a diagram for a set of libraries using the specified options. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">libraries(Project,Libraries,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">libraries(+atom,+list(atom),+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="libraries-2">
<span id="diagram-1-libraries-2"></span><span id="index-2"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">libraries/2</span></code></a><a class="headerlink" href="#libraries-2" title="Link to this heading"></a></h3>
<p>Creates a diagram for a set of libraries using the default options. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">libraries(Project,Libraries)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">libraries(+atom,+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="libraries-1">
<span id="diagram-1-libraries-1"></span><span id="index-3"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">libraries/1</span></code></a><a class="headerlink" href="#libraries-1" title="Link to this heading"></a></h3>
<p>Creates a diagram for a set of libraries using the default options. The prefix <code class="docutils literal notranslate"><span class="pre">libraries</span></code> is used for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">libraries(Libraries)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">libraries(+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="all-libraries-1">
<span id="diagram-1-all-libraries-1"></span><span id="index-4"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">all_libraries/1</span></code></a><a class="headerlink" href="#all-libraries-1" title="Link to this heading"></a></h3>
<p>Creates a diagram for all loaded libraries using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">all_libraries(Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">all_libraries(+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="all-libraries-0">
<span id="diagram-1-all-libraries-0"></span><span id="index-5"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">all_libraries/0</span></code></a><a class="headerlink" href="#all-libraries-0" title="Link to this heading"></a></h3>
<p>Creates a diagram for all loaded libraries using default options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">all_libraries</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="rlibrary-2">
<span id="diagram-1-rlibrary-2"></span><span id="index-6"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">rlibrary/2</span></code></a><a class="headerlink" href="#rlibrary-2" title="Link to this heading"></a></h3>
<p>Creates a diagram for a library and its sub-libraries using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rlibrary(Library,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rlibrary(+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="rlibrary-1">
<span id="diagram-1-rlibrary-1"></span><span id="index-7"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">rlibrary/1</span></code></a><a class="headerlink" href="#rlibrary-1" title="Link to this heading"></a></h3>
<p>Creates a diagram for a library and its sub-libraries using default options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rlibrary(Library)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rlibrary(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="library-2">
<span id="diagram-1-library-2"></span><span id="index-8"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">library/2</span></code></a><a class="headerlink" href="#library-2" title="Link to this heading"></a></h3>
<p>Creates a diagram for a library using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">library(Library,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">library(+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="library-1">
<span id="diagram-1-library-1"></span><span id="index-9"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">library/1</span></code></a><a class="headerlink" href="#library-1" title="Link to this heading"></a></h3>
<p>Creates a diagram for a library using default options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">library(Library)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">library(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="directories-3">
<span id="diagram-1-directories-3"></span><span id="index-10"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">directories/3</span></code></a><a class="headerlink" href="#directories-3" title="Link to this heading"></a></h3>
<p>Creates a diagram for a set of directories using the specified options. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directories(Project,Directories,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directories(+atom,+list(atom),+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="directories-2">
<span id="diagram-1-directories-2"></span><span id="index-11"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">directories/2</span></code></a><a class="headerlink" href="#directories-2" title="Link to this heading"></a></h3>
<p>Creates a diagram for a set of directories using the default options. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directories(Project,Directories)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directories(+atom,+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="rdirectory-3">
<span id="diagram-1-rdirectory-3"></span><span id="index-12"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">rdirectory/3</span></code></a><a class="headerlink" href="#rdirectory-3" title="Link to this heading"></a></h3>
<p>Creates a diagram for a directory and its sub-directories using the specified options. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rdirectory(Project,Directory,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rdirectory(+atom,+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="rdirectory-2">
<span id="diagram-1-rdirectory-2"></span><span id="index-13"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">rdirectory/2</span></code></a><a class="headerlink" href="#rdirectory-2" title="Link to this heading"></a></h3>
<p>Creates a diagram for a directory and its sub-directories using default options. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rdirectory(Project,Directory)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rdirectory(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="rdirectory-1">
<span id="diagram-1-rdirectory-1"></span><span id="index-14"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">rdirectory/1</span></code></a><a class="headerlink" href="#rdirectory-1" title="Link to this heading"></a></h3>
<p>Creates a diagram for a directory and its sub-directories using default options. The name of the directory is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rdirectory(Directory)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">rdirectory(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="directory-3">
<span id="diagram-1-directory-3"></span><span id="index-15"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">directory/3</span></code></a><a class="headerlink" href="#directory-3" title="Link to this heading"></a></h3>
<p>Creates a diagram for a directory using the specified options. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(Project,Directory,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(+atom,+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="directory-2">
<span id="diagram-1-directory-2"></span><span id="index-16"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">directory/2</span></code></a><a class="headerlink" href="#directory-2" title="Link to this heading"></a></h3>
<p>Creates a diagram for a directory using default options. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(Project,Directory)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(+atom,+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="directory-1">
<span id="diagram-1-directory-1"></span><span id="index-17"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">directory/1</span></code></a><a class="headerlink" href="#directory-1" title="Link to this heading"></a></h3>
<p>Creates a diagram for a directory using default options. The name of the directory is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(Directory)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">directory(+atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="files-3">
<span id="diagram-1-files-3"></span><span id="index-18"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">files/3</span></code></a><a class="headerlink" href="#files-3" title="Link to this heading"></a></h3>
<p>Creates a diagram for a set of files using the specified options. The file can be specified by name, basename, full path, or using library notation. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">files(Project,Files,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">files(+atom,+list(atom),+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="files-2">
<span id="diagram-1-files-2"></span><span id="index-19"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">files/2</span></code></a><a class="headerlink" href="#files-2" title="Link to this heading"></a></h3>
<p>Creates a diagram for a set of files using the default options. The file can be specified by name, basename, full path, or using library notation. The <code class="docutils literal notranslate"><span class="pre">Project</span></code> argument is used as a prefix for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">files(Project,Files)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">files(+atom,+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="files-1">
<span id="diagram-1-files-1"></span><span id="index-20"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">files/1</span></code></a><a class="headerlink" href="#files-1" title="Link to this heading"></a></h3>
<p>Creates a diagram for a set of files using the default options. The file can be specified by name, basename, full path, or using library notation. The prefix <code class="docutils literal notranslate"><span class="pre">files</span></code> is used for the diagram file name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">files(Files)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">files(+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="all-files-1">
<span id="diagram-1-all-files-1"></span><span id="index-21"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">all_files/1</span></code></a><a class="headerlink" href="#all-files-1" title="Link to this heading"></a></h3>
<p>Creates a diagram for all loaded files using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">all_files(Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">all_files(+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="all-files-0">
<span id="diagram-1-all-files-0"></span><span id="index-22"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">all_files/0</span></code></a><a class="headerlink" href="#all-files-0" title="Link to this heading"></a></h3>
<p>Creates a diagram for all loaded files using default options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">all_files</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="format-object-1">
<span id="diagram-1-format-object-1"></span><span id="index-23"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">format_object/1</span></code></a><a class="headerlink" href="#format-object-1" title="Link to this heading"></a></h3>
<p>Returns the identifier of the object implementing the graph language currently being used. Fails if none is specified.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">format_object(Object)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">format_object(-object_identifier)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="diagram-description-1">
<span id="diagram-1-diagram-description-1"></span><span id="index-24"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">diagram_description/1</span></code></a><a class="headerlink" href="#diagram-description-1" title="Link to this heading"></a></h3>
<p>Returns the diagram description.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">diagram_description(Description)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">diagram_description(-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="diagram-name-suffix-1">
<span id="diagram-1-diagram-name-suffix-1"></span><span id="index-25"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">diagram_name_suffix/1</span></code></a><a class="headerlink" href="#diagram-name-suffix-1" title="Link to this heading"></a></h3>
<p>Returns the diagram name suffix.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">diagram_name_suffix(Suffix)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">diagram_name_suffix(-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<section id="protected-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Protected predicates</a><a class="headerlink" href="#protected-predicates" title="Link to this heading"></a></h2>
<section id="diagram-caption-3">
<span id="diagram-1-diagram-caption-3"></span><span id="index-26"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">diagram_caption/3</span></code></a><a class="headerlink" href="#diagram-caption-3" title="Link to this heading"></a></h3>
<p>Creates a diagram caption from the diagram description and the subject and its kind.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">diagram_caption(Kind,Subject,Description)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">diagram_caption(+atom,+callable,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-rlibrary-3">
<span id="diagram-1-output-rlibrary-3"></span><span id="index-27"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_rlibrary/3</span></code></a><a class="headerlink" href="#output-rlibrary-3" title="Link to this heading"></a></h3>
<p>Generates diagram output for a library and its sub-libraries using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_rlibrary(Library,Path,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_rlibrary(+atom,+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-library-3">
<span id="diagram-1-output-library-3"></span><span id="index-28"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_library/3</span></code></a><a class="headerlink" href="#output-library-3" title="Link to this heading"></a></h3>
<p>Generates diagram output for a library using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_library(Library,Path,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_library(+atom,+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-rdirectory-3">
<span id="diagram-1-output-rdirectory-3"></span><span id="index-29"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_rdirectory/3</span></code></a><a class="headerlink" href="#output-rdirectory-3" title="Link to this heading"></a></h3>
<p>Generates diagram output for a directory and its sub-directories using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_rdirectory(Project,Path,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_rdirectory(+atom,+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-externals-1">
<span id="diagram-1-output-externals-1"></span><span id="index-30"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_externals/1</span></code></a><a class="headerlink" href="#output-externals-1" title="Link to this heading"></a></h3>
<p>Output external nodes using the specified options depending on the value of the boolean option <code class="docutils literal notranslate"><span class="pre">externals/1</span></code>.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_externals(Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_externals(+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-files-2">
<span id="diagram-1-output-files-2"></span><span id="index-31"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_files/2</span></code></a><a class="headerlink" href="#output-files-2" title="Link to this heading"></a></h3>
<p>Generates diagram output for a list of files using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_files(Files,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_files(+list,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-file-4">
<span id="diagram-1-output-file-4"></span><span id="index-32"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_file/4</span></code></a><a class="headerlink" href="#output-file-4" title="Link to this heading"></a></h3>
<p>Generates diagram output for a file using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_file(Path,Basename,Directory,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_file(+atom,+atom,+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-sub-diagrams-1">
<span id="diagram-1-output-sub-diagrams-1"></span><span id="index-33"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_sub_diagrams/1</span></code></a><a class="headerlink" href="#output-sub-diagrams-1" title="Link to this heading"></a></h3>
<p>Outputs sub-diagrams using the specified options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_sub_diagrams(Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_sub_diagrams(+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="reset-0">
<span id="diagram-1-reset-0"></span><span id="index-34"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">reset/0</span></code></a><a class="headerlink" href="#reset-0" title="Link to this heading"></a></h3>
<p>Resets all temporary information used when generating a diagram.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">reset</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-node-6">
<span id="diagram-1-output-node-6"></span><span id="index-35"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_node/6</span></code></a><a class="headerlink" href="#output-node-6" title="Link to this heading"></a></h3>
<p>Outputs a graph node.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_node(Identifier,Label,Caption,Contents,Kind,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_node(+nonvar,+nonvar,+nonvar,+list(nonvar),+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="node-6">
<span id="diagram-1-node-6"></span><span id="index-36"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">node/6</span></code></a><a class="headerlink" href="#node-6" title="Link to this heading"></a></h3>
<p>Enumerates, by backtracking, all saved nodes.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">node(Identifier,Label,Caption,Contents,Kind,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">node(?nonvar,?nonvar,?nonvar,?list(compound),?atom,?list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="edge-5">
<span id="diagram-1-edge-5"></span><span id="index-37"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">edge/5</span></code></a><a class="headerlink" href="#edge-5" title="Link to this heading"></a></h3>
<p>Enumerates, by backtracking, all saved edges.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">edge(From,To,Labels,Kind,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">edge(?nonvar,?nonvar,?list(nonvar),?atom,?list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-edges-1">
<span id="diagram-1-output-edges-1"></span><span id="index-38"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_edges/1</span></code></a><a class="headerlink" href="#output-edges-1" title="Link to this heading"></a></h3>
<p>Outputs all edges.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_edges(Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_edges(+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="save-edge-5">
<span id="diagram-1-save-edge-5"></span><span id="index-39"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">save_edge/5</span></code></a><a class="headerlink" href="#save-edge-5" title="Link to this heading"></a></h3>
<p>Saves a graph edge.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">save_edge(From,To,Labels,Kind,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">save_edge(+nonvar,+nonvar,+list(nonvar),+atom,+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-missing-externals-1">
<span id="diagram-1-output-missing-externals-1"></span><span id="index-40"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_missing_externals/1</span></code></a><a class="headerlink" href="#output-missing-externals-1" title="Link to this heading"></a></h3>
<p>Outputs missing external nodes (usually due to unloaded resources) that are referenced from edges.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_missing_externals(Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_missing_externals(+list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="not-excluded-file-4">
<span id="diagram-1-not-excluded-file-4"></span><span id="index-41"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">not_excluded_file/4</span></code></a><a class="headerlink" href="#not-excluded-file-4" title="Link to this heading"></a></h3>
<p>True when the given file is not excluded from the generated output. Excluded files may be specified by full path or by basename and with or without extension. Excluded directories may be listed by full or relative path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">not_excluded_file(Path,Basename,ExcludedDirectories,ExcludedFiles)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">not_excluded_file(+atom,+atom,+list(atom),+list(atom))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="output-file-path-4">
<span id="diagram-1-output-file-path-4"></span><span id="index-42"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">output_file_path/4</span></code></a><a class="headerlink" href="#output-file-path-4" title="Link to this heading"></a></h3>
<p>Returns the output file path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_file_path(Name,Options,Format,Path)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">output_file_path(+atom,+list(atom),+object_identifier,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="locate-library-2">
<span id="diagram-1-locate-library-2"></span><span id="index-43"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">locate_library/2</span></code></a><a class="headerlink" href="#locate-library-2" title="Link to this heading"></a></h3>
<p>Locates a library given its name.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">locate_library(Library,Path)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">locate_library(+atom,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="locate-directory-2">
<span id="diagram-1-locate-directory-2"></span><span id="index-44"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">locate_directory/2</span></code></a><a class="headerlink" href="#locate-directory-2" title="Link to this heading"></a></h3>
<p>Locates a directory given its name or full path.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">locate_directory(Directory,Path)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">locate_directory(+atom,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="locate-file-5">
<span id="diagram-1-locate-file-5"></span><span id="index-45"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">locate_file/5</span></code></a><a class="headerlink" href="#locate-file-5" title="Link to this heading"></a></h3>
<p>Locates a file given its name, basename, full path, or library notation representation.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">locate_file(File,Basename,Extension,Directory,Path)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">locate_file(+atom,+atom,+atom,+atom,-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="ground-entity-identifier-3">
<span id="diagram-1-ground-entity-identifier-3"></span><span id="index-46"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">ground_entity_identifier/3</span></code></a><a class="headerlink" href="#ground-entity-identifier-3" title="Link to this heading"></a></h3>
<p>Converts an entity identifier to a ground term.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">ground_entity_identifier(Kind,Identifier,GroundIdentifier)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">ground_entity_identifier(+atom,+callable,-callable)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="filter-file-extension-3">
<span id="diagram-1-filter-file-extension-3"></span><span id="index-47"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">filter_file_extension/3</span></code></a><a class="headerlink" href="#filter-file-extension-3" title="Link to this heading"></a></h3>
<p>Filters the file name extension depending on the <code class="docutils literal notranslate"><span class="pre">file_extensions/1</span></code> option.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">filter_file_extension(Basename,Options,Name)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">filter_file_extension(+atom,+list(compound),-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="filter-external-file-extension-3">
<span id="diagram-1-filter-external-file-extension-3"></span><span id="index-48"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">filter_external_file_extension/3</span></code></a><a class="headerlink" href="#filter-external-file-extension-3" title="Link to this heading"></a></h3>
<p>Filters the external file name extension depending on the <code class="docutils literal notranslate"><span class="pre">file_extensions/1</span></code> option.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">filter_external_file_extension(Path,Options,Name)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">filter_external_file_extension(+atom,+list(compound),-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="add-link-options-3">
<span id="diagram-1-add-link-options-3"></span><span id="index-49"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">add_link_options/3</span></code></a><a class="headerlink" href="#add-link-options-3" title="Link to this heading"></a></h3>
<p>Adds <code class="docutils literal notranslate"><span class="pre">url/1</span></code>, <code class="docutils literal notranslate"><span class="pre">urls/2</span></code>, and <code class="docutils literal notranslate"><span class="pre">tooltip/1</span></code> link options (for use by the graph language) based on the specified path to the list of options.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">add_link_options(Path,Options,LinkingOptions)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">add_link_options(+atom,+list(compound),-list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="supported-editor-url-scheme-prefix-1">
<span id="diagram-1-supported-editor-url-scheme-prefix-1"></span><span id="index-50"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">supported_editor_url_scheme_prefix/1</span></code></a><a class="headerlink" href="#supported-editor-url-scheme-prefix-1" title="Link to this heading"></a></h3>
<p>Table of prefixes for text editors that supports a URL scheme to open diagram links.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">supported_editor_url_scheme_prefix(Prefix)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">supported_editor_url_scheme_prefix(?atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="omit-path-prefix-3">
<span id="diagram-1-omit-path-prefix-3"></span><span id="index-51"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">omit_path_prefix/3</span></code></a><a class="headerlink" href="#omit-path-prefix-3" title="Link to this heading"></a></h3>
<p>Removes a prefix from a path, returning the relative path, when using the option <code class="docutils literal notranslate"><span class="pre">omit_path_prefixes/1</span></code>. Used mainly for constructing directory and file node identifiers and captions.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">omit_path_prefix(Path,Options,Relative)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">omit_path_prefix(+atom,+list(compound),-atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="add-node-zoom-option-4">
<span id="diagram-1-add-node-zoom-option-4"></span><span id="index-52"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">add_node_zoom_option/4</span></code></a><a class="headerlink" href="#add-node-zoom-option-4" title="Link to this heading"></a></h3>
<p>Adds node zoom options when using the zoom option.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">add_node_zoom_option(Identifier,Suffix,Options,NodeOptions)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">add_node_zoom_option(+atom,+atom,+list(compound),-list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="message-diagram-description-1">
<span id="diagram-1-message-diagram-description-1"></span><span id="index-53"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">message_diagram_description/1</span></code></a><a class="headerlink" href="#message-diagram-description-1" title="Link to this heading"></a></h3>
<p>Diagram description for progress messages.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">static</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">message_diagram_description(Description)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">message_diagram_description(?atom)</span></code> - <code class="docutils literal notranslate"><span class="pre">one</span></code></div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<section id="private-predicates">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Private predicates</a><a class="headerlink" href="#private-predicates" title="Link to this heading"></a></h2>
<section id="id1">
<span id="index-54"></span><span id="id2"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">node_/6</span></code></a><a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
<p>Table of saved nodes.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">node_(Identifier,Label,Caption,Contents,Kind,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">node_(?nonvar,?nonvar,?nonvar,?list(compound),?atom,?list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="node-path-2">
<span id="diagram-1-node-path-2"></span><span id="index-55"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">node_path_/2</span></code></a><a class="headerlink" href="#node-path-2" title="Link to this heading"></a></h3>
<p>Table of node paths.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">node_path_(Node,Path)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">node_path_(?ground,?list(ground))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
<hr class="docutils" />
</section>
<section id="id3">
<span id="index-56"></span><span id="id4"></span><h3><a class="toc-backref" href="#contents" role="doc-backlink"><code class="docutils literal notranslate"><span class="pre">edge_/5</span></code></a><a class="headerlink" href="#id3" title="Link to this heading"></a></h3>
<p>Table of saved edges.</p>
<div class="line-block">
<div class="line"><strong>Compilation flags:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">dynamic</span></code></div>
</div>
</div>
<div class="line-block">
<div class="line"><strong>Template:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">edge_(From,To,Labels,Kind,Options)</span></code></div>
</div>
<div class="line"><strong>Mode and number of proofs:</strong></div>
<div class="line-block">
<div class="line"><code class="docutils literal notranslate"><span class="pre">edge_(?nonvar,?nonvar,?list(nonvar),?atom,?list(compound))</span></code> - <code class="docutils literal notranslate"><span class="pre">zero_or_more</span></code></div>
</div>
</div>
</section>
</section>
<hr class="docutils" />
<section id="operators">
<h2><a class="toc-backref" href="#contents" role="doc-backlink">Operators</a><a class="headerlink" href="#operators" title="Link to this heading"></a></h2>
<p>(none)</p>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="d2_graph_language_0.html" class="btn btn-neutral float-left" title="d2_graph_language" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="diagrams_0.html" class="btn btn-neutral float-right" title="diagrams" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 1998-2025, Paulo Moura.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>